-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
📖 Advertise struct pointer requirement for Create #2017
📖 Advertise struct pointer requirement for Create #2017
Conversation
Make it explicit in the function comments that the "obj" argument of the Client interface's Create method must be a struct pointer, because implementers will store in it the object returned by the K8s API server.
Welcome @matteoolivi! |
Hi @matteoolivi. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
The generated godocs pages are just generated by whoever hosts them (e.g. https://pkg.go.dev/), so they are not stored in the repo. /lgtm |
/test pull-controller-runtime-test-master |
@sbueringer is something missing for the approved label? |
No I think this should be fine. I'm just not a maintainer/approver so I can only lgtm |
/assign @vincepri |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alvaroaleman, matteoolivi The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Make it explicit in the function comments that the "obj" argument of the Client interface's Create method must be a struct pointer, because implementers will store in it the object returned by the K8s API server.
The added statement was already present on
Update
andPatch
methods, but not onCreate
.Note:This comment will end up in the godoc of the package, but I couldn't find the godocs in the repo, so I don't know how to update the godocs.